Application Service > ROLE > API v3ガイド

ROLEサービスを利用して権限をチェックするためには RESTful APIを呼び出すか、クライアントSDKを利用する必要があります。

アプリケーションキー&秘密鍵

RESTful APIとクライアントSDKを使用するには、アプリケーションキーと秘密鍵が必要です。 [CONSOLE] 右上のURL & Appkeyボタンをクリックすると、発行キー情報を確認できます。

[図1]アプリケーションキー&秘密鍵確認

[図1]アプリケーションキー&秘密鍵の確認

RESTful APIガイド

Common Response Body

すべてのAPIリクエストに対してHTTPレスポンスコードは200でレスポンスします。 詳細なレスポンス結果はResponse Bodyのheader項目を参照してください。

{
  "cache": {
    "cacheFlushTime": "",
    "size": 0,
    "sizeTree": 1,
    "ttl": 5,
    "sizeByPath": 6
  },
  "header": {
    "isSuccessful": true,
    "resultCode": 5,
    "resultMessage": "resultMessage"
  }
}
Key Type Description
header Object レスポンスヘッダ
header.isSuccessful boolean 成否
header.resultCode int レスポンスコード。成功時は0、失敗時はエラーコードを返す
header.resultMessage String レスポンスメッセージ。成功時は"SUCCESS"、失敗時はエラーメッセージを返す
cache Object キャッシュ
cache.cacheFlushTime String キャッシュ削除時間
cache.size int リソースIDベースの認証キャッシュサイズ
cache.sizeByPath int リソースPathベースの認証キャッシュサイズ
cache.sizeTree int リソースHierarchy照会キャッシュサイズ
cache.ttl int キャッシュデータ維持時間(秒単位)

ユーザー

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/users ユーザーの作成
DELETE /role/v3.0/appkeys/{appKey}/users/{userId} ユーザーの削除
DELETE /role/v3.0/appkeys/{appKey}/users ユーザーの一括削除
POST /role/v3.0/appkeys/{appKey}/users/id すべてのユーザーIDリストの照会
GET /role/v3.0/appkeys/{appKey}/users/{userId} ユーザー情報照会
GET /role/v3.0/appkeys/{appKey}/users/{userId}/histories ユーザーに割り当てられたロールの変更履歴リストの照会
POST /role/v3.0/appkeys/{appKey}/users/search ユーザーリストの照会
PUT /role/v3.0/appkeys/{appKey}/users/{userId} ユーザーの修正
PUT /role/v3.0/appkeys/{appKey}/users/{userId}/scopes/{scopeId} ユーザースコープ限定修正

ユーザーの作成

POST "/role/v3.0/appkeys/{appKey}/users"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body CreateUserRequest CreateUserRequest Yes
CreateUserRequest
Name Type Required Description
users List<CreateUserRequest.UserProtocol> Yes ユーザーリスト
CreateUserRequest.UserProtocol
Name Type Required Description
description String No ユーザーの説明
roleRelations List<UserRoleRelationProtocol> No ユーザー関連ロール
userId String Yes ユーザーID
UserRoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No ロール条件属性
roleApplyPolicyCode String No ALLOW, DENY
roleId String Yes ロールID
scopeId String Yes スコープID
ConditionProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ユーザーの削除

DELETE "/role/v3.0/appkeys/{appKey}/users/{userId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path userId String Yes ユーザーID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ユーザーの一括削除

DELETE "/role/v3.0/appkeys/{appKey}/users"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body userIds List<String> Yes ユーザーIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

すべてのユーザーIDリストの照会

POST "/role/v3.0/appkeys/{appKey}/users/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.userId,ASC)
Request Body SearchUser.Request SearchUser.Request Yes
SearchUser.Request
Name Type Required Description
descriptionLike String No ユーザーの説明(部分一致)
needRoleRelations Boolean No レスポンス時に関連ロール関係を含めるかどうか(デフォルト値: true)
needRoleTags Boolean No レスポンス時にロール関連関係を含める場合、ロールタグを含めるかどうか(デフォルト値: false)
needRoleCount Boolean No レスポンス時、ユーザーが持つロール数を含めるかどうか(デフォルト値: false)
roleIdPreLike String No ロールID(前方一致)
roleIds List<String> No ロールIDリスト(完全一致)
scopeIdPreLike String No スコープID(前方一致)
scopeIds List<String> No スコープIDリスト(完全一致)
searchRoleOptionCode String No DIRECT_ROLE, INDIRECT_ROLE
userIdPreLike String No ユーザーID(前方一致)
userIds List<String> No ユーザーIDリスト(完全一致)

Response Body

{
  "totalItems" : 0,
  "userIds" : [ "userIds", "userIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAllUser.Response
Name Type Required Description
totalItems Long Yes 全体数
userIds List<String> Yes ユーザーリスト

ユーザー情報照会

GET "/role/v3.0/appkeys/{appKey}/users/{userId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path userId String Yes ユーザーID
Query searchRoleOptionCode String No アクセス可能なロールリスト検索方式
Query roleIds List<String> No 関連関係ロールID
Query scopeIds List<String> No 関連関係スコープID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "user" : {
    "roleRelations" : [ {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "userId" : "userId"
  }
}
GetUser.Response
Name Type Required Description
user UserBundleProtocol Yes ユーザー
UserBundleProtocol
Name Type Required Description
description String No 説明
regYmdt Date No ユーザー作成日時
roleRelations List<UserBundleProtocol.UserRoleRelationBundleProtocol> No ユーザーに割り当てられたロールリスト
userId String Yes ユーザーID
UserBundleProtocol.UserRoleRelationBundleProtocol
Name Type Required Description
conditions List<ConditionBundleProtocol> No ロール条件属性
description String No ロールの説明
exposureOrder Integer Yes 表示順序
regYmdt Date No 登録日時
roleApplyPolicyCode String Yes ALLOW, DENY
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名
roleTags List<UserBundleProtocol.RoleTagProtocol> No ロールタグリスト
scopeId String Yes スコープID
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes 条件属性
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
description String No 条件属性の説明
UserBundleProtocol.RoleTagProtocol
Name Type Required Description
roleTagId String No ロールタグID

ユーザーに割り当てられたロールの変更履歴リストの照会

GET "/role/v3.0/appkeys/{appKey}/users/{userId}/histories"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path userId String Yes ユーザーID
Query roleId String No ロールID
Query scopeId String No スコープID
Query fromDateTime Date No 変更開始日時
Query toDateTime Date No 変更終了日時
Query historyType List<String> No 変更タイプ
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値seq,DESC)

Response Body

{
  "totalItems" : 0,
  "userHistory" : [ {
    "executionTime" : "2000-01-23T04:56:07.000+00:00",
    "scopeId" : "scopeId",
    "userHistorySeq" : 6,
    "roleId" : "roleId",
    "operatorUuid" : "operatorUuid",
    "conditions" : [ {
      "attributeId" : "instance.name",
      "attributeValues" : [ "attributeValues", "attributeValues" ],
      "attribute" : {
        "attributeId" : "attributeId",
        "description" : "description",
        "attributeName" : "attributeName"
      }
    }, {
      "attributeId" : "instance.name",
      "attributeValues" : [ "attributeValues", "attributeValues" ],
      "attribute" : {
        "attributeId" : "attributeId",
        "description" : "description",
        "attributeName" : "attributeName"
      }
    } ],
    "userId" : "userId"
  }, {
    "executionTime" : "2000-01-23T04:56:07.000+00:00",
    "scopeId" : "scopeId",
    "userHistorySeq" : 6,
    "roleId" : "roleId",
    "operatorUuid" : "operatorUuid",
    "conditions" : [ {
      "attributeId" : "instance.name",
      "attributeValues" : [ "attributeValues", "attributeValues" ],
      "attribute" : {
        "attributeId" : "attributeId",
        "description" : "description",
        "attributeName" : "attributeName"
      }
    }, {
      "attributeId" : "instance.name",
      "attributeValues" : [ "attributeValues", "attributeValues" ],
      "attribute" : {
        "attributeId" : "attributeId",
        "description" : "description",
        "attributeName" : "attributeName"
      }
    } ],
    "userId" : "userId"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetUserHistory.Response
Name Type Required Description
totalItems Long Yes 全体数
userHistory List<UserHistoryProtocol> Yes ユーザー変更履歴リスト
UserHistoryProtocol
Name Type Required Description
command String Yes USER_ADD, USER_REMOVE, ADD, REMOVE
conditions List<ConditionBundleProtocol> No ロール条件属性
executionTime Date Yes 変更日時
operatorUuid String No 作業者UUID
roleApplyPolicyCode String No ALLOW, DENY
roleId String No ロールID
scopeId String No スコープID
userHistorySeq Long Yes ユーザー変更履歴シリアル番号
userId String Yes ユーザーID
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes 条件属性
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
description String No 条件属性の説明

ユーザーリストの照会

POST "/role/v3.0/appkeys/{appKey}/users/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.userId,ASC)
Request Body SearchUser.Request SearchUser.Request Yes
SearchUser.Request
Name Type Required Description
descriptionLike String No ユーザーの説明(部分一致)
needRoleRelations Boolean No レスポンス時に関連ロール関係を含めるかどうか(デフォルト値: true)
needRoleTags Boolean No レスポンス時にロール関連関係を含める場合、ロールタグを含めるかどうか(デフォルト値: false)
needRoleCount Boolean No レスポンス時にユーザーが持つロール数を含めるかどうか(デフォルト値: false)
roleIdPreLike String No ロールID(前方一致)
roleIds List<String> No ロールIDリスト(完全一致)
scopeIdPreLike String No スコープID(前方一致)
scopeIds List<String> No スコープIDリスト(完全一致)
searchRoleOptionCode String No DIRECT_ROLE, INDIRECT_ROLE
userIdPreLike String No ユーザーID(前方一致)
userIds List<String> No ユーザーIDリスト(完全一致)

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "users" : [ {
    "roleRelations" : [ {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "userId" : "userId",
    "roleCounts": [
      {
        "roleCount": 2,
        "scopeId": "scopeId"
      }
    ]
  }, {
    "roleRelations" : [ {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "scopeId" : "scopeId",
      "exposureOrder" : 6,
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "userId" : "userId",
    "roleCounts": [
      {
        "roleCount": 2,
        "scopeId": "scopeId"
      }
    ]
  } ]
}
SearchUser.Response
Name Type Required Description
totalItems Long Yes 全体数
users List<UserBundleProtocol> Yes ユーザーリスト
UserBundleProtocol
Name Type Required Description
description String No 説明
regYmdt Date No ユーザー作成日時
roleRelations List<UserBundleProtocol.UserRoleRelationBundleProtocol> No ユーザーに割り当てられたロールリスト
userId String Yes ユーザーID
roleCounts List<UserRoleCountProtocol> No ユーザーに割り当てられたロール数
UserBundleProtocol.UserRoleRelationBundleProtocol
Name Type Required Description
conditions List<ConditionBundleProtocol> No ロール条件属性
description String No ロールの説明
exposureOrder Integer Yes 表示順序
regYmdt Date No 登録日時
roleApplyPolicyCode String Yes ALLOW, DENY
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名
roleTags List<UserBundleProtocol.RoleTagProtocol> No ロールタグリスト
scopeId String Yes スコープID
UserBundleProtocol.UserRoleCountProtocol
Name Type Required Description
scopeId String Yes スコープID
roleCount Long Yes スコープID別のロール数
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes 条件属性
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
description String No 条件属性の説明
UserBundleProtocol.RoleTagProtocol
Name Type Required Description
roleTagId String No ロールタグID

ユーザーの修正

PUT "/role/v3.0/appkeys/{appKey}/users/{userId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path userId String Yes ユーザーID
Request Body PutUserRequest PutUserRequest Yes ユーザー
PutUserRequest
Name Type Required Description
user PutUserRequest.UserProtocol Yes ユーザー
createUserIfNotExist Boolean No リクエスト時に存在しない場合、ユーザーを作成するかどうか
PutUserRequest.UserProtocol
Name Type Required Description
description String No ユーザーの説明
roleRelations List<UserRoleRelationProtocol> No ユーザー関連ロール
UserRoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No ロール条件属性
roleApplyPolicyCode String No ALLOW, DENY
roleId String Yes ロールID
scopeId String Yes スコープID
ConditionProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ユーザースコープ限定修正

PUT "/role/v3.0/appkeys/{appKey}/users/{userId}/scopes/{scopeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path userId String Yes ユーザーID
Path scopeId String Yes スコープID
Request Body putUserScopeRequest PutUserScopeRequest Yes ユーザー
PutUserScopeRequest
Name Type Required Description
user PutUserScopeRequest.UserProtocol Yes ユーザー
createUserIfNotExist Boolean No リクエスト時に存在しない場合、ユーザーを作成するかどうか
PutUserScopeRequest.UserProtocol
Name Type Required Description
description String No ユーザーの説明
roleRelations List<UserScopeRoleRelationProtocol> No ユーザー関連ロール
UserScopeRoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No ロール条件属性
roleApplyPolicyCode String No ALLOW, DENY
roleId String Yes ロールID
ConditionProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ユーザー認証

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/users/{userId}/authorizations/resources ユーザーがリソースにアクセス権限があるかどうか検査
POST /role/v3.0/appkeys/{appKey}/users/{userId}/authorizations/roles ユーザーがロールにアクセスできる権限があるかどうか検査

ユーザーがリソースのアクセス権限があるかどうか検査

POST "/role/v3.0/appkeys/{appKey}/users/{userId}/authorizations/resources"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path userId String Yes ユーザーID
Request Body PostAuthorizationResource.Request PostAuthorizationResource.Request Yes リソースリスト
PostAuthorizationResource.Request
Name Type Required Description
resources List<PostAuthorizationResource.ResourceProtocol> Yes リソースリスト
PostAuthorizationResource.ResourceProtocol
Name Type Required Description
attributes List<PostAuthorizationResource.AttributeProtocol> No 条件属性ID
authRequestId String No リクエスト認証識別キー
operationId String Yes オペレーションID
resourceId String No リソースID
resourcePath String No リソースPath
scopeId String No スコープID
PostAuthorizationResource.AttributeProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeValue String Yes 条件属性値

Response Body

{
  "authorizations" : [ {
    "resourceId" : "resourceId",
    "scopeId" : "scopeId",
    "resourcePath" : "resourcePath",
    "authRequestId" : "authRequestId",
    "operationId" : "operationId",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    }, {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    } ],
    "permission" : true
  }, {
    "resourceId" : "resourceId",
    "scopeId" : "scopeId",
    "resourcePath" : "resourcePath",
    "authRequestId" : "authRequestId",
    "operationId" : "operationId",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    }, {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    } ],
    "permission" : true
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
PostAuthorizationResource.Response
Name Type Required Description
authorizations List<PostAuthorizationResource.AuthorizationWithResourceProtocol> No 権限チェック結果リスト
PostAuthorizationResource.AuthorizationWithResourceProtocol
Name Type Required Description
attributes List<PostAuthorizationResource.AttributeProtocol> Yes 条件属性ID
authRequestId String No リクエスト認証識別キー
operationId String Yes オペレーションID
permission Boolean Yes 権限の有無
resourceId String No リソースID
resourcePath String No リソースPath
scopeId String Yes スコープID
PostAuthorizationResource.AttributeProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeValue String Yes 条件属性値

ユーザーがロールにアクセス権限があるかどうかを検査

POST "/role/v3.0/appkeys/{appKey}/users/{userId}/authorizations/roles"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path userId String Yes ユーザーID
Request Body PostAuthorizationRole.Request PostAuthorizationRole.Request Yes
PostAuthorizationRole.Request
Name Type Required Description
roles List<PostAuthorizationRole.AuthRoleProtocol> Yes 認証リクエストリスト
PostAuthorizationRole.AuthRoleProtocol
Name Type Required Description
attributes List<PostAuthorizationRole.AttributeProtocol> No 条件属性
authRequestId String No 認証リクエスト識別キー
roleId String Yes ロールID
scopeId String No スコープID
PostAuthorizationRole.AttributeProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeValue String Yes 条件属性値

Response Body

{
  "authorizations" : [ {
    "scopeId" : "scopeId",
    "roleId" : "roleId",
    "authRequestId" : "authRequestId",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    }, {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    } ],
    "permission" : true
  }, {
    "scopeId" : "scopeId",
    "roleId" : "roleId",
    "authRequestId" : "authRequestId",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    }, {
      "attributeId" : "attributeId",
      "attributeValue" : "attributeValue"
    } ],
    "permission" : true
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
PostAuthorizationRole.Response
Name Type Required Description
authorizations List<PostAuthorizationRole.AuthorizationProtocol> No 権限チェック結果リスト
PostAuthorizationRole.AuthorizationProtocol
Name Type Required Description
attributes List<PostAuthorizationRole.AttributeProtocol> Yes 条件属性ID
authRequestId String No リクエスト認証識別キー
permission Boolean Yes 権限の有無
roleId String Yes ロールID
scopeId String Yes スコープID
PostAuthorizationRole.AttributeProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeValue String Yes 条件属性値

ロール

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/roles ロールの作成
DELETE /role/v3.0/appkeys/{appKey}/roles/{roleId} ロールの削除
DELETE /role/v3.0/appkeys/{appKey}/roles ロールの一括削除
GET /role/v3.0/appkeys/{appKey}/roles/{roleId}/deniable ロール使用有無をDENY(未使用)に変更可能かどうか
GET /role/v3.0/appkeys/{appKey}/roles/{roleId} ロール単件照会
GET /role/v3.0/appkeys/{appKey}/roles/id すべてのロールIDリストの照会
POST /role/v3.0/appkeys/{appKey}/roles/{roleId}/attributes/search ロールで設定可能なすべての条件属性リストの照会
POST /role/v3.0/appkeys/{appKey}/roles/search ロールリストの照会
PUT /role/v3.0/appkeys/{appKey}/roles/{roleId} ロール修正

ロールの作成

POST "/role/v3.0/appkeys/{appKey}/roles"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body CreateRoleRequest CreateRoleRequest Yes
CreateRoleRequest
Name Type Required Description
role RoleProtocol No ロール
roleRelations List<CreateRoleRequest.RoleRelationProtocol> No 条件属性と関連するロールIDリスト
roleTags List<CreateRoleRequest.RoleTagProtocol> No ロールタグリスト
RoleProtocol
Name Type Required Description
description String No ロールの説明
exposureOrder Integer Yes 表示順序
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名
CreateRoleRequest.RoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No ロール条件属性
relatedRoleId String Yes 条件属性と関連するロールID
roleApplyPolicyCode String No ALLOW, DENY
ConditionProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値
CreateRoleRequest.RoleTagProtocol
Name Type Required Description
roleTagId String Yes ロールタグID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ロールの削除

DELETE "/role/v3.0/appkeys/{appKey}/roles/{roleId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path roleId String Yes ロールID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ロールの一括削除

DELETE "/role/v3.0/appkeys/{appKey}/roles/{roleId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body roleIds List<String> Yes ロールIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ロール使用有無をDENY(未使用)に変更可能かどうか

GET "/role/v3.0/appkeys/{appKey}/roles/{roleId}/deniable"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path roleId String Yes ロールID

Response Body

{
  "deniable" : true,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetDeniableResponse
Name Type Required Description
deniable Boolean No ロール使用有無をDENY(未使用)に変更可能かどうか

ロール単件照会

GET "/role/v3.0/appkeys/{appKey}/roles/{roleId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path roleId String Yes ロールID

Response Body

{
  "role" : {
    "regDateTime" : "2000-01-23T04:56:07.000+00:00",
    "roleRelations" : [ {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    }, {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    } ],
    "exposureOrder" : 0,
    "roleTags" : [ {
      "roleTagId" : "roleTagId"
    }, {
      "roleTagId" : "roleTagId"
    } ],
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "appKey" : "appKey",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    }, {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    } ],
    "roleGroup" : "roleGroup"
  },
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetRoleResponse
Name Type Required Description
role RoleBundleProtocol Yes ロール
RoleBundleProtocol
Name Type Required Description
appKey String Yes アプリケーションキー
attributes List<AttributeProtocol> No 条件属性リスト
description String No ロールの説明
exposureOrder Integer Yes 表示順序
regDateTime Date Yes ロール作成日時
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名
roleRelations List<RoleBundleProtocol.RoleRelationProtocol> No 関連関係ロールリスト
roleTags List<RoleBundleProtocol.RoleTagProtocol> No ロールタグリスト
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
description String No 条件属性の説明
RoleBundleProtocol.RoleRelationProtocol
Name Type Required Description
conditions List<ConditionBundleProtocol> No ロール条件属性
description String No ロールの説明
regDateTime Date Yes ロール作成日時
roleApplyPolicyCode String Yes ALLOW, DENY
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名
roleTags List<RoleBundleProtocol.RoleTagProtocol> No 役割タグリスト
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes 条件属性
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
description String No 条件属性の説明
RoleBundleProtocol.RoleTagProtocol
Name Type Required Description
roleTagId String No ロールタグID

すべてのロールIDリストの照会

GET "/role/v3.0/appkeys/{appKey}/roles/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query roleIdPreLike String No ロールID(前方一致)
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.roleId,ASC)

Response Body

{
  "totalItems" : 0,
  "roleIds" : [ "roleIds", "roleIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAllRoleIds.Response
Name Type Required Description
roleIds List<String> Yes ロールIDリスト
totalItems Long Yes 全体数

ロールで設定可能なすべての条件属性リストの照会

POST "/role/v3.0/appkeys/{appKey}/roles/{roleId}/attributes/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path roleId String Yes ロールID
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値attributeCreationTypeCode,ASC&quot;,&quot;id.attributeId,ASC)
Request Body SearchRoleAttributes.Request SearchRoleAttributes.Request Yes
SearchRoleAttributes.Request
Name Type Required Description
attributeIds List<String> No 条件属性IDリスト(完全一致)
attributeNameLike String No 条件属性名(部分一致)
attributeTagIds List<String> No 条件属性タグIDリスト(完全一致)

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "attributes" : [ {
    "attributeId" : "attributeId",
    "description" : "description",
    "attributeName" : "attributeName"
  }, {
    "attributeId" : "attributeId",
    "description" : "description",
    "attributeName" : "attributeName"
  } ]
}
SearchRoleAttributes.Response
Name Type Required Description
attributes List<AttributeProtocol> Yes ロールに付与可能な条件属性リスト
totalItems Long Yes 全体数
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
description String No 条件属性の説明

ロールリストの照会

POST "/role/v3.0/appkeys/{appKey}/roles/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値exposureOrder,ASC&quot;,&quot;id.roleId,ASC)
Request Body GetRoles.Request GetRoles.Request Yes
GetRoles.Request
Name Type Required Description
attributeIds List<String> No 条件属性IDリスト(完全一致)
attributeTagIds List<String> No 条件属性タグIDリスト(完全一致)
descriptionLike String No ロールの説明(部分一致)
needAttributes Boolean No レスポンス時に条件属性情報を含めるかどうか
needRoleRelations Boolean No レスポンス時にロール関連関係IDリストを含めるかどうか
needRoleTags Boolean No レスポンス時にロールタグIDリストを含めるかどうか
relatedRoleIds List<String> No 関連関係ロールIDリスト(完全一致)
roleGroup String No ロールグループ(完全一致)
roleGroupLike String No ロールグループ(部分一致)
roleIdPreLike String No ロールID(前方一致)
roleIds List<String> No ロールIDリスト(完全一致)
roleNameLike String No ロール名(部分一致)
roleTagIdExpr String No ロールタグ条件(セパレータ';':OR, ',':AND)
roleTagIds List<String> No ロールタグIDリスト(完全一致)

Response Body

{
  "totalItems" : 6,
  "roles" : [ {
    "regDateTime" : "2000-01-23T04:56:07.000+00:00",
    "roleRelations" : [ {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    }, {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    } ],
    "exposureOrder" : 0,
    "roleTags" : [ {
      "roleTagId" : "roleTagId"
    }, {
      "roleTagId" : "roleTagId"
    } ],
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "appKey" : "appKey",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    }, {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    } ],
    "roleGroup" : "roleGroup"
  }, {
    "regDateTime" : "2000-01-23T04:56:07.000+00:00",
    "roleRelations" : [ {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "roleTags" : [ {
        "roleTagId" : "roleTagId"
      }, {
        "roleTagId" : "roleTagId"
      } ],
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    }, {
      "regDateTime" : "2000-01-23T04:56:07.000+00:00",
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "conditions" : [ {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      }, {
        "attributeId" : "instance.name",
        "attributeValues" : [ "attributeValues", "attributeValues" ],
        "attribute" : {
          "attributeId" : "attributeId",
          "description" : "description",
          "attributeName" : "attributeName"
        }
      } ],
      "roleGroup" : "roleGroup"
    } ],
    "exposureOrder" : 0,
    "roleTags" : [ {
      "roleTagId" : "roleTagId"
    }, {
      "roleTagId" : "roleTagId"
    } ],
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "appKey" : "appKey",
    "attributes" : [ {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    }, {
      "attributeId" : "attributeId",
      "description" : "description",
      "attributeName" : "attributeName"
    } ],
    "roleGroup" : "roleGroup"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetRoles.Response
Name Type Required Description
roles List<RoleBundleProtocol> Yes ロールリスト
totalItems Long Yes ロールの総数
RoleBundleProtocol
Name Type Required Description
appKey String Yes アプリケーションキー
attributes List<AttributeProtocol> No 条件属性リスト
description String No ロールの説明
exposureOrder Integer Yes 表示順序
regDateTime Date Yes ロール作成日時
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名
roleRelations List<RoleBundleProtocol.RoleRelationProtocol> No 関連関係ロールリスト
roleTags List<RoleBundleProtocol.RoleTagProtocol> No ロールタグリスト
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
description String No 条件属性の説明
RoleBundleProtocol.RoleRelationProtocol
Name Type Required Description
conditions List<ConditionBundleProtocol> No ロール条件属性
description String No ロールの説明
regDateTime Date Yes ロール作成日時
roleApplyPolicyCode String Yes ALLOW, DENY
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名
roleTags List<RoleBundleProtocol.RoleTagProtocol> No 役割タグリスト
ConditionBundleProtocol
Name Type Required Description
attribute AttributeProtocol Yes 条件属性
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
description String No 条件属性の説明
RoleBundleProtocol.RoleTagProtocol
Name Type Required Description
roleTagId String No ロールタグID

ロールの修正

PUT "/role/v3.0/appkeys/{appKey}/roles/{roleId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path roleId String Yes ロールID
Request Body UpdateRoleRequest UpdateRoleRequest Yes
UpdateRoleRequest
Name Type Required Description
role RoleMetadataProtocol No ロール
roleRelations List<UpdateRoleRequest.RoleRelationProtocol> No 条件属性と関連するロールIDリスト
roleTags List<UpdateRoleRequest.RoleTagProtocol> No ロールタグリスト
RoleMetadataProtocol
Name Type Required Description
description String No ロールの説明
exposureOrder Integer Yes 表示順序
roleGroup String No ロールグループ
roleName String No ロール名
UpdateRoleRequest.RoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No ロール条件属性
relatedRoleId String Yes 条件属性と関連するロールID
roleApplyPolicyCode String No ALLOW, DENY
ConditionProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値
UpdateRoleRequest.RoleTagProtocol
Name Type Required Description
roleTagId String Yes ロールタグID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ロールタグ

Method HTTP request Description
GET /role/v3.0/appkeys/{appKey}/roles/tags/id すべてのロールタグIDリストの照会

すべてのロールタグIDリストの照会

GET "/role/v3.0/appkeys/{appKey}/roles/tags/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query roleTagIdPreLike String No ロールタグID(前方一致)
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.roleTagId,ASC)

Response Body

{
  "totalItems" : 0,
  "roleTagIds" : [ "roleTagIds", "roleTagIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAllRoleTagIds.Response
Name Type Required Description
roleTagIds List<String> No ロールタグIDリスト
totalItems Long Yes 全体数

ロール関連関係

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/roles/{roleId}/relations ロール関連関係の一括作成
DELETE /role/v3.0/appkeys/{appKey}/roles/{roleId}/relations} ロール関連関係の一括削除
PUT /role/v3.0/appkeys/{appKey}/roles/{roleId}/relations ロール関連関係の一括修正

ロール関連関係の一括作成

POST "/role/v3.0/appkeys/{appKey}/roles/{roleId}/relations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path roleId String Yes ロールID
Request Body CreateRoleRelationRequest CreateRoleRelationRequest Yes
CreateRoleRelationRequest
Name Type Required Description
roleRelations List<RoleRelationProtocol> Yes ロール関連関係リスト
RoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No ロール条件属性
relatedRoleId String Yes 条件属性と関連するロールID
roleApplyPolicyCode String No ALLOW, DENY
ConditionProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ロール関連関係の一括削除

DELETE "/role/v3.0/appkeys/{appKey}/roles/{roleId}/relations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path roleId String Yes ロールID
Request Body DeleteRoleRelationRequest DeleteRoleRelationRequest Yes
DeleteRoleRelationRequest
Name Type Required Description
relatedRoleIds List<String> Yes 関連関係ロールIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

ロール関連関係の一括修正

PUT "/role/v3.0/appkeys/{appKey}/roles/{roleId}/relations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path roleId String Yes ロールID
Request Body UpdateRoleRelationRequest UpdateRoleRelationRequest Yes
UpdateRoleRelationRequest
Name Type Required Description
roleRelations List<RoleRelationProtocol> Yes ロール関連関係リスト
RoleRelationProtocol
Name Type Required Description
conditions List<ConditionProtocol> No ロール条件属性
relatedRoleId String Yes 条件属性と関連するロールID
roleApplyPolicyCode String No ALLOW, DENY
ConditionProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

スコープ

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/scopes スコープの作成
DELETE /role/v3.0/appkeys/{appKey}/scopes/{scopeId} スコープの削除
DELETE /role/v3.0/appkeys/{appKey}/scopes スコープの一括削除
GET /role/v3.0/appkeys/{appKey}/scopes/id すべてのスコープIDリストの照会
GET /role/v3.0/appkeys/{appKey}/scopes/{scopeId} スコープ単件照会
POST /role/v3.0/appkeys/{appKey}/scopes/search スコープリストの照会
PUT /role/v3.0/appkeys/{appKey}/scopes/{scopeId} スコープ修正

スコープ作成

POST "/role/v3.0/appkeys/{appKey}/scopes"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body CreateScope.Request CreateScope.Request Yes
CreateScope.Request
Name Type Required Description
description String No スコープ説明
scopeId String Yes スコープID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

スコープ削除

DELETE "/role/v3.0/appkeys/{appKey}/scopes/{scopeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path scopeId String Yes スコープID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

スコープの一括削除

DELETE "/role/v3.0/appkeys/{appKey}/scopes"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body scopeIds List<String> Yes スコープIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

すべてのスコープIDリストの照会

GET "/role/v3.0/appkeys/{appKey}/scopes/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query scopeIdPreLike String No スコープID(前方一致)
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.scopeId,ASC)

Response Body

{
  "totalItems" : 0,
  "scopeIds" : [ "scopeIds", "scopeIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAllScopeIds.Response
Name Type Required Description
scopeIds List<String> No スコープIDリスト
totalItems Long Yes 全体数

スコープ単件照会

GET "/role/v3.0/appkeys/{appKey}/scopes/{scopeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path scopeId String Yes スコープID

Response Body

{
  "scope" : {
    "scopeId" : "scopeId",
    "description" : "description"
  },
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetScope.Response
Name Type Required Description
scope ScopeProtocol No スコープ
ScopeProtocol
Name Type Required Description
description String No スコープ説明
scopeId String Yes スコープID

スコープリストの照会

POST "/role/v3.0/appkeys/{appKey}/scopes/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.scopeId,ASC)
Request Body PostSearchScopes.Request PostSearchScopes.Request Yes
PostSearchScopes.Request
Name Type Required Description
descriptionLike String No スコープの説明(部分一致)
scopeIdPreLike String No スコープID(前方一致)
scopeIds List<String> No スコープIDリスト(完全一致)

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "scopes" : [ {
    "scopeId" : "scopeId",
    "description" : "description"
  }, {
    "scopeId" : "scopeId",
    "description" : "description"
  } ]
}
PostSearchScopes.Response
Name Type Required Description
scopes List<ScopeProtocol> No スコープリスト
totalItems Long No スコープの総数
ScopeProtocol
Name Type Required Description
description String No スコープ説明
scopeId String Yes スコープID

スコープの修正

PUT "/role/v3.0/appkeys/{appKey}/scopes/{scopeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path scopeId String Yes スコープID
Request Body UpdateScope.Request UpdateScope.Request Yes
UpdateScope.Request
Name Type Required Description
description String No 説明

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

リソース

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/resources リソースの作成
DELETE /role/v3.0/appkeys/{appKey}/resources/{resourceId} リソースの削除
DELETE /role/v3.0/appkeys/{appKey}/resources リソースの一括削除
GET /role/v3.0/appkeys/{appKey}/resources/{resourceId} リソース単件照会
POST /role/v3.0/appkeys/{appKey}/resources/id リソースIDリストの照会
GET /role/v3.0/appkeys/{appKey}/resources リソースリストの照会
POST /role/v3.0/appkeys/{appKey}/resources/attributes/search リソースで設定可能なすべての条件属性リストの照会
POST /role/v3.0/appkeys/{appKey}/resources/search リソースリストの照会
PUT /role/v3.0/appkeys/{appKey}/resources/{resourceId} リソースの修正

リソースの作成

POST "/role/v3.0/appkeys/{appKey}/resources"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body CreateResource.Request CreateResource.Request Yes
CreateResource.Request
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
path String Yes リソースPath
priority Integer Yes 優先順位
resourceId String No リソースID
uiPath String Yes リソースUI Path

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

リソースの削除

DELETE "/role/v3.0/appkeys/{appKey}/resources/{resourceId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path resourceId String Yes リソースID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

リソースの一括削除

DELETE "/role/v3.0/appkeys/{appKey}/resources"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body resourceIds List<String> Yes リソースIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

リソース単件照会

GET "/role/v3.0/appkeys/{appKey}/resources/{resourceId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path resourceId String Yes リソースID

Response Body

{
  "resource" : {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  },
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetResource.Response
Name Type Required Description
resource ResourceProtocol No リソース
ResourceProtocol
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
path String Yes リソースPath
priority Integer Yes 優先順位
resourceId String No リソースID
uiPath String Yes リソースUI Path

リソースIDリストの照会

POST "/role/v3.0/appkeys/{appKey}/resources/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.resourceId,ASC)
Request Body GetAllResourceIds.Request GetAllResourceIds.Request Yes
GetAllResourceIds.Request
Name Type Required Description
operationIds List<String> No リソースID(前方一致)
resourceIdPreLike String No リソースにアクセス可能なユーザーID
roleIds List<String> No リソースに付与されたロールID
userIds List<String> No リソースに付与されたOperation ID

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "resourceIds" : [ "resourceIds", "resourceIds" ]
}
GetAllResourceIds.Response
Name Type Required Description
resourceIds List<String> Yes リソースIDリスト
totalItems Long Yes 全体数

リソースリストの照会

GET "/role/v3.0/appkeys/{appKey}/resources"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query userId String No リソースにアクセス可能なユーザーID
Query roleId String No リソースに付与されたロールID
Query operationId String No リソースに付与されたOperation ID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "resources" : [ {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  }, {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  } ]
}
GetResources.Response
Name Type Required Description
resources List<ResourceProtocol> No リソースリスト
ResourceProtocol
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
path String Yes リソースPath
priority Integer Yes 優先順位
resourceId String No リソースID
uiPath String Yes リソースUI Path

リソースで設定可能なすべての条件属性リストの照会

POST "/role/v3.0/appkeys/{appKey}/resources/attributes/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.attributeId,ASC)
Request Body SearchResourceAttributes.Request SearchResourceAttributes.Request Yes
SearchResourceAttributes.Request
Name Type Required Description
operationId String Yes オペレーションID
resourceId String No リソースID。IDとPathが両方ある場合、ID基準でのみ提供
resourcePath String No リソースPath

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "attributes" : [ {
    "attributeId" : "attributeId",
    "description" : "description",
    "attributeName" : "attributeName"
  }, {
    "attributeId" : "attributeId",
    "description" : "description",
    "attributeName" : "attributeName"
  } ]
}
SearchResourceAttributes.Response
Name Type Required Description
attributes List<AttributeProtocol> Yes リソースに付与可能な条件属性リスト
totalItems Long Yes 全体数
AttributeProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
description String No 条件属性の説明

リソースリストの照会

POST "/role/v3.0/appkeys/{appKey}/resources/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値uiPath,ASC)
Request Body PostSearchResources.Request PostSearchResources.Request Yes
PostSearchResources.Request
Name Type Required Description
operationIds List<String> No リソースに付与されたOperation IDリスト
resourceIdPreLike String No リソースID(前方一致)
resourceIds List<String> No リソースIDリスト
resourcePath String No リソースPath(完全一致)
resourcePathLike String No リソースPath(前方一致)
resourcePaths List<String> No リソースPathリスト(完全一致)
resourceUiPath String No リソースUI Path(完全一致)
resourceUiPaths List<String> No リソースUI Pathリスト(完全一致)
roleIds List<String> No リソースに付与されたロールIDリスト
scopeIds List<String> No リソースにアクセス可能なスコープIDリスト
searchRoleOptionCode String No アクセス可能なロールリスト検索方式 DIRECT_ROLE, INDIRECT_ROLE
userIds List<String> No リソースにアクセス可能なユーザーIDリスト

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "resources" : [ {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  }, {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  } ]
}
PostSearchResources.Response
Name Type Required Description
resources List<ResourceProtocol> Yes リソースリスト
totalItems Long Yes 全体数
ResourceProtocol
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
path String Yes リソースPath
priority Integer Yes 優先順位
resourceId String No リソースID
uiPath String Yes リソースUI Path

**リソースの修正

PUT "/role/v3.0/appkeys/{appKey}/resources/{resourceId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path resourceId String Yes リソースID
Request Body UpdateResource.Request UpdateResource.Request Yes
UpdateResource.Request
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
newResourceId String No 変更するリソースID
path String Yes リソースPath
priority Integer Yes 優先順位
uiPath String Yes リソースUI Path

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

リソース階層構造

Method HTTP request Description
GET /role/v3.0/appkeys/{appKey}/resources/{resourceId}/sub-resources ui path上の下位リソースページ照会
POST /role/v3.0/appkeys/{appKey}/resources/hierarchy/search リソースHierarchy照会

ui path上の下位リソースページ照会

GET "/role/v3.0/appkeys/{appKey}/resources/{resourceId}/sub-resources"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path resourceId String Yes リソースID
Query userId String No ユーザーID
Query roleId String No ロールID
Query operationId String No オペレーションID
Query scopeId String No スコープID
Query depth Integer No リソースUI Pathの下位の階層の深さ
Query limit Integer No 返すリストの位置。 default: INT_MAX
Query offset Integer No 返すリストの開始位置。 default: 0

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "resources" : [ {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  }, {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "priority" : -27519,
    "uiPath" : "uiPath"
  } ],
  "totalItemCount" : 0
}
GetSubResources.Response
Name Type Required Description
resources List<ResourceProtocol> No リソースリスト
totalItemCount Long No リソースの総数
ResourceProtocol
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
path String Yes リソースPath
priority Integer Yes 優先順位
resourceId String No リソースID
uiPath String Yes リソースUI Path

リソースHierarchy照会

POST "/role/v3.0/appkeys/{appKey}/resources/hierarchy/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body SearchResourceHierarchy.Request SearchResourceHierarchy.Request Yes
SearchResourceHierarchy.Request
Name Type Required Description
operationIds List<String> No リソースに割り当てられたオペレーションIDリスト
resourceIds List<String> No 階層構造のRoot Resource IDリスト
resourcePath String No 階層構造のRoot Resource Path
resourceUiPath String No 階層構造のRoot Resource Ui Path
roleIds List<String> No リソースに割り当てられたロールIDリスト
scopeIds List<String> No ユーザーに割り当てられたスコープIDリスト
userIds List<String> No リソースにアクセス可能なユーザーIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "resources" : [ {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "resources" : [ null, null ],
    "priority" : -27519,
    "uiPath" : "uiPath"
  }, {
    "path" : "path",
    "metadata" : "metadata",
    "resourceId" : "resourceId",
    "name" : "name",
    "description" : "description",
    "resources" : [ null, null ],
    "priority" : -27519,
    "uiPath" : "uiPath"
  } ]
}
SearchResourceHierarchy.Response
Name Type Required Description
resources Set No リソース階層構造リスト
SearchResourceHierarchy.ResourceHierarchyProtocol
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
path String Yes リソースPath
priority Integer Yes 優先順位
resourceId String No リソースID
resources Set No 子階層のリソースリスト
uiPath String Yes リソースUI Path
SearchResourceHierarchy.ResourceHierarchyProtocol
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
path String Yes リソースPath
priority Integer Yes 優先順位
resourceId String No リソースID
resources Set No 子階層のリソースリスト
uiPath String Yes リソースUI Path
SearchResourceHierarchy.ResourceHierarchyProtocol
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
path String Yes リソースPath
priority Integer Yes 優先順位
resourceId String No リソースID
resources Set No 子階層のリソースリスト
uiPath String Yes リソースUI Path
SearchResourceHierarchy.ResourceHierarchyProtocol
Name Type Required Description
description String No リソースの説明
metadata String No メタデータ
name String No リソース名
path String Yes リソースPath
priority Integer Yes 優先順位
resourceId String No リソースID
resources Set No 子階層のリソースリスト
uiPath String Yes リソースUI Path

(../Models/SearchResourceHierarchy.ResourceHierarchyProtocol.md)

リソース関連ロール

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations リソースロール関連関係を追加
GET /role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations リソースロール関連関係リストの照会
DELETE /role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations リソースロール関連関係を削除

リソースロール関連関係の追加

POST "/role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path resourceId String Yes リソースID
Request Body AddAuthorization.Request AddAuthorization.Request Yes
AddAuthorization.Request
Name Type Required Description
operationId String Yes オペレーションID
propagation Boolean No Rootを除いた全ての親Pathに指定したロールを同じように適用するかどうか
roleId String Yes ロールID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

リソースロール関連関係リストの照会

GET "/role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path resourceId String Yes リソースID

Response Body

{
  "authorizations" : [ {
    "resourceId" : "resourceId",
    "roleId" : "roleId",
    "operationId" : "operationId"
  }, {
    "resourceId" : "resourceId",
    "roleId" : "roleId",
    "operationId" : "operationId"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAuthorizations.Response
Name Type Required Description
authorizations List<ResourceAuthorizationProtocol> No リソースロール関連関係リスト
ResourceAuthorizationProtocol
Name Type Required Description
operationId String Yes オペレーションID
resourceId String Yes リソースID
roleId String Yes ロールID

リソースロール関連関係の削除

DELETE "/role/v3.0/appkeys/{appKey}/resources/{resourceId}/authorizations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path resourceId String Yes リソースID
Query operationId String Yes オペレーションID
Query roleId String Yes ロールID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

オペレーション

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/operations オペレーションの作成
DELETE /role/v3.0/appkeys/{appKey}/operations/{operationId} オペレーションの削除
DELETE /role/v3.0/appkeys/{appKey}/operations オペレーションの一括削除
GET /role/v3.0/appkeys/{appKey}/operations/{operationId} オペレーション単件照会
GET /role/v3.0/appkeys/{appKey}/operations/id すべてのオペレーションID照会
POST /role/v3.0/appkeys/{appKey}/operations/search オペレーションリストの照会(条件/ページング)
PUT /role/v3.0/appkeys/{appKey}/operations/{operationId} オペレーションの修正

オペレーションの作成

POST "/role/v3.0/appkeys/{appKey}/operations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body CreateOperation.Request CreateOperation.Request Yes
CreateOperation.Request
Name Type Required Description
description String No オペレーションの説明
operationId String Yes オペレーションID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

オペレーションの削除

DELETE "/role/v3.0/appkeys/{appKey}/operations/{operationId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path operationId String Yes オペレーションID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

オペレーションの一括削除

DELETE "/role/v3.0/appkeys/{appKey}/operations"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body operationIds List<String> Yes オペレーションIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

オペレーション単件照会

GET "/role/v3.0/appkeys/{appKey}/operations/{operationId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path operationId String Yes オペレーションID

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "operation" : {
    "description" : "description",
    "operationId" : "operationId",
    "appKey" : "appKey"
  }
}
GetOperation.Response
Name Type Required Description
operation OperationResponseProtocol Yes オペレーション
OperationResponseProtocol
Name Type Required Description
appKey String No アプリケーションキー
description String No オペレーションの説明
operationId String Yes オペレーションID

すべてのオペレーションID照会

GET "/role/v3.0/appkeys/{appKey}/operations/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query operationIdPreLike String No オペレーションID(前方一致)
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.operationId,ASC)

Response Body

{
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "operationIds" : [ "operationIds", "operationIds" ]
}
GetAllOperationIds.Response
Name Type Required Description
operationIds List<String> Yes オペレーションIDリスト
totalItems Long Yes 全体数

オペレーションリストの照会(条件/ページング)

POST "/role/v3.0/appkeys/{appKey}/operations/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.operationId,ASC)
Request Body PostSearchOperations.Request PostSearchOperations.Request Yes
PostSearchOperations.Request
Name Type Required Description
descriptionLike String No オペレーションの説明(部分一致)
operationIdPreLike String No オペレーションID(前方一致)
operationIds List<String> No オペレーションIDリスト(完全一致)

Response Body

{
  "totalItems" : 0,
  "operations" : [ {
    "description" : "description",
    "operationId" : "operationId",
    "appKey" : "appKey"
  }, {
    "description" : "description",
    "operationId" : "operationId",
    "appKey" : "appKey"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
PostSearchOperations.Response
Name Type Required Description
operations List<OperationResponseProtocol> Yes オペレーションリスト
totalItems Long Yes 全体数
OperationResponseProtocol
Name Type Required Description
appKey String No アプリケーションキー
description String No オペレーションの説明
operationId String Yes オペレーションID

オペレーションの修正

PUT "/role/v3.0/appkeys/{appKey}/operations/{operationId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path operationId String Yes オペレーションID
Request Body UpdateOperation.Request UpdateOperation.Request Yes
UpdateOperation.Request
Name Type Required Description
description String No オペレーションの説明

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/attributes 条件属性の作成
DELETE /role/v3.0/appkeys/{appKey}/attributes/{attributeId} 条件属性の削除
DELETE /role/v3.0/appkeys/{appKey}/attributes 条件属性の一括削除
GET /role/v3.0/appkeys/{appKey}/attributes/{attributeId} 条件属性の単件照会
POST /role/v3.0/appkeys/{appKey}/attributes/id 条件属性IDリストの照会
POST /role/v3.0/appkeys/{appKey}/attributes/search 条件属性リストの照会
PUT /role/v3.0/appkeys/{appKey}/attributes/{attributeId} 条件属性の修正

条件属性の作成

POST "/role/v3.0/appkeys/{appKey}/attributes"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body CreateAttribute.Request CreateAttribute.Request Yes
CreateAttribute.Request
Name Type Required Description
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
attributeRoleRelationIds List<String> No 条件属性と関連するロールIDリスト
attributeTagIds List<String> No 条件属性タグIDリスト
description String No 条件属性の説明

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性の削除

DELETE "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path attributeId String Yes 条件属性ID
Query forceDelete Boolean No 強制削除、デフォルト値(false)

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性の一括削除

DELETE "/role/v3.0/appkeys/{appKey}/attributes"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body attributeIds List<String> Yes 条件属性IDリスト
Request Body forceDelete Boolean No 強制削除、デフォルト値(false)

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性単件照会

GET "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path attributeId String Yes 条件属性ID

Response Body

{
  "attributeInUse" : true,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "attribute" : {
    "attributeId" : "attributeId",
    "attributeRoleRelations" : [ {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "attributeTags" : [ {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "description" : "description",
    "attributeName" : "attributeName"
  }
}
GetAttribute.Response
Name Type Required Description
attribute AttributeBundleProtocol Yes 条件属性
attributeInUse Boolean Yes 条件属性を使用するかどうか
AttributeBundleProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
attributeRoleRelations List<AttributeRoleRelationProtocol> Yes 条件属性と関連するロールIDリスト
attributeTags List<AttributeTagProtocol> Yes 条件属性タグID
description String No 条件属性の説明
AttributeRoleRelationProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
description String No ロールの説明
exposureOrder Integer Yes 表示順序
regYmdt Date Yes 条件属性と関連するロールIDの作成日時
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名
AttributeTagProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeTagId String Yes 条件属性タグID
regYmdt Date Yes 条件属性タグの作成日時

条件属性IDリストの照会

POST "/role/v3.0/appkeys/{appKey}/attributes/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.attributeId,ASC)
Request Body SearchAttributes.Request SearchAttributes.Request Yes
SearchAttributes.Request
Name Type Required Description
attributeCreationTypeCodes List<AttributeCreationTypeCode> No 条件属性作成タイプリスト
attributeDataTypeCodes List<AttributeDataTypeCode> No 条件属性データタイプ
attributeIdPreLike String No 条件属性ID(前方一致)
attributeIds List<String> No 条件属性IDリスト(完全一致)
attributeTagIds List<String> No 条件属性タグIDリスト(完全一致)
descriptionLike String No 条件属性説明(部分一致)
roleIdPreLike String No ロールID(前方一致)
roleIds List<String> No ロールIDリスト(完全一致)

Response Body

{
  "totalItems" : 0,
  "attributeIds" : [ "attributeIds", "attributeIds" ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAttributeIds.Response
Name Type Required Description
attributeIds List<String> Yes 条件属性IDリスト
totalItems Long Yes ロールの総数

ロールで設定可能なすべての条件属性リストの照会

POST "/role/v3.0/appkeys/{appKey}/attributes/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.attributeId,ASC)
Request Body SearchAttributes.Request SearchAttributes.Request Yes
SearchAttributes.Request
Name Type Required Description
attributeCreationTypeCodes List<AttributeCreationTypeCode> No 条件属性作成タイプリスト
attributeDataTypeCodes List<AttributeDataTypeCode> No 条件属性データタイプ
attributeIdPreLike String No 条件属性ID(前方一致)
attributeIds List<String> No 条件属性IDリスト(完全一致)
attributeTagIds List<String> No 条件属性タグIDリスト(完全一致)
descriptionLike String No 条件属性説明(部分一致)
roleIdPreLike String No ロールID(前方一致)
roleIds List<String> No ロールIDリスト(完全一致)

Response Body

{
  "totalItems" : 6,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  },
  "attributes" : [ {
    "attributeId" : "attributeId",
    "attributeRoleRelations" : [ {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "attributeTags" : [ {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "description" : "description",
    "attributeName" : "attributeName"
  }, {
    "attributeId" : "attributeId",
    "attributeRoleRelations" : [ {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    }, {
      "attributeId" : "attributeId",
      "exposureOrder" : 0,
      "roleId" : "roleId",
      "roleName" : "roleName",
      "description" : "description",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00",
      "roleGroup" : "roleGroup"
    } ],
    "attributeTags" : [ {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "attributeId" : "attributeId",
      "attributeTagId" : "attributeTagId",
      "regYmdt" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "description" : "description",
    "attributeName" : "attributeName"
  } ]
}
SearchAttributes.Response
Name Type Required Description
attributes List<AttributeBundleProtocol> Yes 条件属性リスト
totalItems Long Yes ロールの総数
AttributeBundleProtocol
Name Type Required Description
attributeCreationTypeCode String Yes COMMON_ATTRIBUTE, ROLE_ATTRIBUTE
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeId String Yes 条件属性ID
attributeName String No 条件属性名
attributeRoleRelations List<AttributeRoleRelationProtocol> Yes 条件属性と関連するロールIDリスト
attributeTags List<AttributeTagProtocol> Yes 条件属性タグID
description String No 条件属性の説明
AttributeRoleRelationProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
description String No ロールの説明
exposureOrder Integer Yes 表示順序
regYmdt Date Yes 条件属性と関連するロールIDの作成日時
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名
AttributeTagProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeTagId String Yes 条件属性タグID
regYmdt Date Yes 条件属性タグの作成日時

条件属性の修正

PUT "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path attributeId String Yes 条件属性ID
Request Body UpdateAttribute.Request UpdateAttribute.Request Yes
UpdateAttribute.Request
Name Type Required Description
attributeDataTypeCode String Yes STRING, NUMERIC, DAY_OF_WEEK, DATETIME, TIME, IPADDRESS, BOOLEAN
attributeName String No 条件属性名
attributeRoleRelationIds List<String> No 条件属性と関連するロールIDリスト
attributeTagIds List<String> No 条件属性タグIDリスト
description String No 条件属性の説明

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性データ型

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/attributes/data-types 条件属性データ型リストの照会
POST /role/v3.0/appkeys/{appKey}/attributes/condition/validate 条件値有効性チェック

条件属性データ型リストの照会

POST "/role/v3.0/appkeys/{appKey}/attributes/data-types"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー

Response Body

{
  "dataTypes" : [ {
    "operators" : [ {
      "min" : 6,
      "max" : 0,
      "operatorTypeCode" : "operatorTypeCode"
    }, {
      "min" : 6,
      "max" : 0,
      "operatorTypeCode" : "operatorTypeCode"
    } ],
    "dataType" : "dataType"
  }, {
    "operators" : [ {
      "min" : 6,
      "max" : 0,
      "operatorTypeCode" : "operatorTypeCode"
    }, {
      "min" : 6,
      "max" : 0,
      "operatorTypeCode" : "operatorTypeCode"
    } ],
    "dataType" : "dataType"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetAttributeDataTypeResponse
Name Type Required Description
dataTypes List<GetAttributeDataTypeResponse.AttributeDataTypeProtocol> Yes 条件属性データ型リスト
GetAttributeDataTypeResponse.AttributeDataTypeProtocol
Name Type Required Description
dataType String Yes 条件属性データ型
operators List<GetAttributeDataTypeResponse.AttributeOperatorTypeProtocol> Yes 条件属性が使用可能な演算子リスト
GetAttributeDataTypeResponse.AttributeOperatorTypeProtocol
Name Type Required Description
max Integer Yes 演算子が使用可能な値の最大数
min Integer Yes 演算子が使用可能な値の最小数
operatorTypeCode String Yes 演算子

条件値有効性チェック

POST "/role/v3.0/appkeys/{appKey}/attributes/condition/validate"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body ValidateConditionValuesRequest ValidateConditionValuesRequest Yes
ValidateConditionValuesRequest
Name Type Required Description
conditions List<ConditionProtocol> Yes ロール条件属性
ConditionProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeOperatorTypeCode String Yes ALL_CONTAINS, ANY_CONTAINS, NOT_CONTAINS, ANY_MATCH, NONE_MATCH, BETWEEN, BEYOND, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO, ALLOW, NOT_ALLOW, TRUE, FALSE
attributeValues List<String> No 条件属性値

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性ロールの関連関係

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles 条件属性と関連するロールの一括作成
DELETE /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles 条件属性と関連するロールの一括削除
POST /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles/search 条件属性と関連するロールリストの照会

条件属性と関連するロールの一括作成

POST "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path attributeId String Yes 条件属性ID
Request Body CreateAttributeRoleRelations.Request CreateAttributeRoleRelations.Request Yes
CreateAttributeRoleRelations.Request
Name Type Required Description
attributeRoleRelationIds List<String> Yes 条件属性と関連するロールIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性と関連するロールの一括削除

DELETE "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path attributeId String Yes 条件属性ID
Request Body DeleteAttributeRoleRelations.Request DeleteAttributeRoleRelations.Request Yes
DeleteAttributeRoleRelations.Request
Name Type Required Description
attributeRoleRelationIds List<String> Yes 条件属性と関連するロールIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性と関連するロールリストの照会

POST "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/roles/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path attributeId String Yes 条件属性ID
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値attribute.id.attributeId,ASC)
Request Body SearchAttributeRoleRelations.Request SearchAttributeRoleRelations.Request Yes
SearchAttributeRoleRelations.Request
Name Type Required Description
roleIdPreLike String No 条件属性と関連するロールID(前方一致)
roleIds List<String> No 条件属性と関連するロールIDリスト(完全一致)
searchRoleOptionCode String No DIRECT_ROLE, INDIRECT_ROLE

Response Body

{
  "attributeRoleRelations" : [ {
    "attributeId" : "attributeId",
    "exposureOrder" : 0,
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "roleGroup" : "roleGroup"
  }, {
    "attributeId" : "attributeId",
    "exposureOrder" : 0,
    "roleId" : "roleId",
    "roleName" : "roleName",
    "description" : "description",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00",
    "roleGroup" : "roleGroup"
  } ],
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAttributeRoleRelations.Response
Name Type Required Description
attributeRoleRelations List<AttributeRoleRelationProtocol> Yes 条件属性関連関係Roleリスト
totalItems Long Yes ロールの総数
AttributeRoleRelationProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
description String No ロールの説明
exposureOrder Integer Yes 表示順序
regYmdt Date Yes 条件属性と関連するロールIDの作成日時
roleGroup String No ロールグループ
roleId String Yes ロールID
roleName String No ロール名

条件属性タグ

Method HTTP request Description
POST /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/tags 条件属性タグの作成
DELETE /role/v3.0/appkeys/{appKey}/attributes/{attributeId}/tags 条件属性タグの削除
POST /role/v3.0/appkeys/{appKey}/attributes/tags/id 条件属性タグIDリストの照会
POST /role/v3.0/appkeys/{appKey}/attributes/tags/search 条件属性タグリストの照会

条件属性タグの作成

POST "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/tags"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path attributeId String Yes 条件属性ID
Request Body CreateAttributeTags.Request CreateAttributeTags.Request Yes
CreateAttributeTags.Request
Name Type Required Description
attributeTagIds List<String> Yes 条件属性タグIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性タグの削除

DELETE "/role/v3.0/appkeys/{appKey}/attributes/{attributeId}/tags"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Path attributeId String Yes 条件属性ID
Request Body DeleteAttributeTags.Request DeleteAttributeTags.Request Yes
DeleteAttributeTags.Request
Name Type Required Description
attributeTagIds List<String> Yes 条件属性タグIDリスト

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

条件属性タグIDリストの照会

POST "/role/v3.0/appkeys/{appKey}/attributes/tags/id"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.attributeTagId,ASC)
Request Body SearchAttributeTagIds.Request SearchAttributeTagIds.Request Yes
SearchAttributeTagIds.Request
Name Type Required Description
attributeIdPreLike String No 条件属性ID(前方一致)
attributeIds List<String> No 条件属性IDリスト(完全一致)
attributeTagIdPreLike String No 条件属性タグID(前方一致)
attributeTagIds List<String> No 条件属性タグIDリスト(完全一致)

Response Body

{
  "attributeTagIds" : [ "attributeTagIds", "attributeTagIds" ],
  "totalItems" : 0,
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAttributeTagIds.Response
Name Type Required Description
attributeTagIds List<String> Yes 条件属性タグIDリスト
totalItems Long Yes ロールの総数

条件属性タグリストの照会

POST "/role/v3.0/appkeys/{appKey}/attributes/tags/search"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Query page Integer No 検索したいページ番号(デフォルト値1)
Query itemsPerPage Integer No 結果を求めるページ別の検索数(デフォルト値10)
Query sort List<String> No ソート順序(デフォルト値id.attributeTagId,ASC)
Request Body SearchAttributeTags.Request SearchAttributeTags.Request Yes
SearchAttributeTags.Request
Name Type Required Description
attributeIdPreLike String No 条件属性ID(前方一致)
attributeIds List<String> No 条件属性IDリスト(完全一致)
attributeTagIdPreLike String No 条件属性タグID(前方一致)
attributeTagIds List<String> No 条件属性タグIDリスト(完全一致)

Response Body

{
  "totalItems" : 0,
  "attributeTags" : [ {
    "attributeId" : "attributeId",
    "attributeTagId" : "attributeTagId",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "attributeId" : "attributeId",
    "attributeTagId" : "attributeTagId",
    "regYmdt" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
SearchAttributeTags.Response
Name Type Required Description
attributeTags List<AttributeTagProtocol> Yes 条件属性タグリスト
totalItems Long Yes ロールの総数
AttributeTagProtocol
Name Type Required Description
attributeId String Yes 条件属性ID
attributeTagId String Yes 条件属性タグID
regYmdt Date Yes 条件属性タグの作成日時

設定

Method HTTP request Description
PUT /role/v3.0/appkeys/{appKey}/config/cache-evict ROLEサービスサーバーとクライアントSDKのキャッシュを削除
GET /role/v3.0/appkeys/{appKey}/config 設定の照会
PUT /role/v3.0/appkeys/{appKey}/config 設定を修正

サーバーとクライアントSDKのキャッシュを削除

PUT "/role/v3.0/appkeys/{appKey}/config/cache-evict"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}

設定の照会

GET "/role/v3.0/appkeys/{appKey}/config"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
GetTenantConfigResponse
Name Type Required Description
resourcePathTrailingSlashMatchPolicyCode String Yes IDENTICAL_PATH, NON_IDENTICAL_PATH

設定の修正

PUT "/role/v3.0/appkeys/{appKey}/config"

Parameters

ParameterType Name Type Required Description
Header X-Secret-Key String Yes 秘密鍵
Path appKey String Yes アプリケーションキー
Request Body UpdateConfig.Request UpdateConfig.Request Yes
UpdateConfig.Request
Name Type Required Description
cacheSize Integer No リソースIDベースの認証キャッシュサイズ
cacheSizeByPath Integer No リソースHierarchy照会キャッシュサイズ
cacheSizeTree Integer No リソースPathベースの認証キャッシュサイズ
cacheTtl Integer No キャッシュデータ維持時間(秒単位)
resourcePathTrailingSlashMatchPolicyCode String No IDENTICAL_PATH, NON_IDENTICAL_PATH

Response Body

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "resultMessage"
  }
}
目次
TOP